

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Define Menu Items [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Add-In,Add-In Create, Define Menu Items,Define Menu Items,Define Menu Items Create Add-In,Menu,Menu Items, Define In Add-In">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Define Menu Items</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="creatingaddins.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="deployingaddins.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">Menu items are defined by responding to the </span><span class="f_BodyText" style="font-style: italic;">GetMenuItems</span><span class="f_BodyText"> event.</span></p>
<p class="p_BodyText"><span class="f_BodyText">The first time this event is called, </span><span class="f_BodyText" style="font-style: italic;">MenuName</span><span class="f_BodyText"> is an empty string, representing the top-level menu. For a simple Add-In with just a single menu option you can return a string; for example:</span></p>
<p class="p_Code"><span class="f_Code">Function EA_GetMenuItems(Repository as EA.Repository, MenuLocation As String, MenuName As String) As Variant</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; EA_GetMenuItems = &quot;&amp;Joe's Add-In&quot;</span></p>
<p class="p_Code"><span class="f_Code">End Function</span></p>
<p class="p_BodyText"><span class="f_BodyText">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">To define sub-menus, prefix a parent menu with a dash. Parent and sub-items are defined as follows:</span></p>
<p class="p_Code"><span class="f_Code">Function EA_GetMenuItems(Repository as EA.Repository, MenuLocation As String, MenuName As String) As Variant</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Select Case MenuName</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;&quot;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp;&nbsp; 'Parent Menu Item</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; EA_GetMenuItems = &quot;-&amp;Joe's Add-In&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;-&amp;Joe's Add-In&quot;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp;&nbsp; 'Define Sub-Menu Items using the Array notation.</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp;&nbsp; 'In this example, &quot;Diagram&quot; and &quot;Treeview&quot; compose the &quot;Joe's Add-In&quot; sub-menu.</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; EA_GetMenuItems = Array(&quot;&amp;Diagram&quot;, &quot;&amp;Treeview&quot;)</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case Else</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; MsgBox &quot;Invalid Menu&quot;, vbCritical</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; End Select</span></p>
<p class="p_Code"><span class="f_Code">End Function</span></p>
<p class="p_BodyText"><span class="f_BodyText">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">Similarly, you can define further sub-items:</span></p>
<p class="p_Code"><span class="f_Code">Function EA_GetMenuItems(Repository as EA.Repository, MenuLocation As String, MenuName As String) As Variant</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Select Case MenuName</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; EA_GetMenuItems = &quot;-Joe's Add-In&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;-Joe's Add-In&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; EA_GetMenuItems = Array(&quot;-&amp;Diagram&quot;, &quot;&amp;TreeView&quot;)</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;-&amp;Diagram&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; EA_GetMenuItems = &quot;&amp;Properties&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case Else</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; MsgBox &quot;Invalid Menu&quot;, vbCritical</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; End Select</span></p>
<p class="p_Code"><span class="f_Code">End Function</span></p>
<p class="p_BodyText"><span class="f_BodyText">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">To enable or disable menu options by default, you can use this method to show particular items to the user:</span></p>
<p class="p_Code"><span class="f_Code">Sub EA_GetMenuState(Repository As EA.Repository, Location As String, MenuName As String, ItemName As String, IsEnabled As Boolean, IsChecked As Boolean)</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Select Case Location</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;TreeView&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'Always enable</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;Diagram&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'Always enable</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; Case &quot;MainMenu&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Select Case ItemName</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Case &quot;&amp;Translate&quot;, &quot;Save &amp;Project&quot;</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; If GetIsProjectSelected() Then</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; IsEnabled = False</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; End If</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; End Select</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; End Select</span></p>
<p class="p_Code"><span class="f_Code"> &nbsp;&nbsp; IsChecked = GetIsCurrentSelection()</span></p>
<p class="p_Code"><span class="f_Code">End Sub</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
